Rewrite documentation #739
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skipci
BREAKING CHANGE: Stop providing the `--logger-uri` option to the CLI
cortadocodes
force-pushed
the
rewrite-docs
branch
from
d0d6609 to
a7ad869
Compare
BREAKING CHANGE: Stop using "example" as a service namespace
BREAKING CHANGE: Use: - `octue twined question ask` instead of `octue twined question ask remote` - `octue twined question ask-local` instead of `octue twined question ask local`
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #739 +/- ##
==========================================
- Coverage 93.98% 93.75% -0.24%
==========================================
Files 97 99 +2
Lines 3858 3904 +46
==========================================
+ Hits 3626 3660 +34
- Misses 232 244 +12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
skipci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contents (#739)
IMPORTANT: There are 3 breaking changes.
New features
octue twined question ask examplecommandExampleChildand use in CLIEnhancements
exampleCLI subcommand intoremotesubcommandExampleChildsame signature asChildExampleChildwithChildwith "example" namespaceFixes
ExampleChild.askDependencies
strincasefrom dev to production dependenciesRefactoring
--logger-urioption from CLIExampleChildExampleChild.__init__Chores
check-yamlpre-commit checkOther
ExampleChildin getting started guideUpgrade instructions
💥 Remove `--logger-uri` option from CLI
Stop providing the
--logger-urioption to the CLI💥 Raise error if "example" is used as a service namespace
Stop using "example" as a service namespace
💥 Un-nest CLI commands for asking questions
Use:
octue twined question askinstead ofoctue twined question ask remoteoctue twined question ask-localinstead ofoctue twined question ask local